home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1995 April / Internet Tools.iso / x25 / nrs.shar.Z / nrs.shar / nrs.txt < prev    next >
Encoding:
Text File  |  1990-04-27  |  22.6 KB  |  859 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.      A Quick Jog Through Configuring The Nrs Processor.
  11.  
  12.  
  13.                        Julian Onions
  14.  
  15.                   Computer Science Group,
  16.                    Nottingham University.
  17.  
  18.  
  19.                         Piete Brooks
  20.  
  21.         University of Cambridge Computer Laboratory,
  22.          New Museum Site, Pembroke Street, CB2 3QG
  23.  
  24.  
  25.                         Adrian Pell
  26.  
  27.               Department of Computer Science,
  28.                    University of Reading.
  29.  
  30.  
  31.  
  32.  
  33.  
  34. _1.  _I_n_t_r_o_d_u_c_t_i_o_n
  35.  
  36. This document describes how to build yourself  a  configura-
  37. tion   file  for  the  nrs  database  cruncher,  hereinafter
  38. referred to as the _n_r_s program.
  39.  
  40. Currently the _n_r_s program runs under UNIX|-  (BSD  4.2/ULTRIX
  41. 1.2  on  VAX  11/750s, VAX 11/780s, Microvax IIs, Orions and
  42. Suns; V7/ULTRIX 11 on PDP/11s; System V  on  GEC  63s),  VMS
  43. (VAX  VMS  C 2.1 on Microvax IIs) and PRIMOS, and can be run
  44. in one of six modes, as detailed in section 3.2,
  45.  
  46. 1)   York X25 directory mode (R2.2 or R2.1)
  47.  
  48. 2)   MMDF table generation mode.
  49.  
  50. 3)   X25hosts directory mode (UBC code).
  51.  
  52. 4)   Text mode (as per t.central, PR1ME and Edinburgh).
  53.  
  54. 5)   VMS mode.
  55.  
  56. 6)   Sendmail mode (UK or Reading versions).
  57.  
  58. _________________________
  59. |- UNIX is a trademark of Bell Laboratories.
  60.  
  61.  
  62.  
  63.  
  64.                       December 3, 1988
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                            - 2 -
  71.  
  72.  
  73. 7)   DBM mode (for unix-niftp)
  74.  
  75. _2.  _T_h_e _N_R_S _D_a_t_a_b_a_s_e _F_o_r_m_a_t
  76.  
  77. This is a brief introduction to the  structure  of  the  NRS
  78. Database. For more details, read the NRS document _M_a_k_i_n_g _a_n_d
  79. _U_s_i_n_g _D_e_r_i_v_e_d _D_a_t_a_b_a_s_e_s by Dr. R.D. Baker,  obtainable  from
  80. the University of Salford.
  81.  
  82. The NRS Database consists of one file which is  made  up  of
  83. the  following  sections  (previously separate files - these
  84. are still accepted):
  85.  
  86. A section known as _M_O_D_U_L_E_2, which contains within it all the
  87. long and short NRS registered hosts together with associated
  88. pointers to the _M_O_D_U_L_E_4 section.
  89.  
  90. A section known as _M_O_D_U_L_E_3, which contains information  used
  91. for reverse lookups and is used if reverse lookups are indi-
  92. cated.
  93.  
  94. A section  known  as  _M_O_D_U_L_E_4,  which  contains  information
  95. groups  of  records called quads which give the filename and
  96. offset in one of the _A_T_O_M_I_C sections.
  97.  
  98. A number of _A_T_O_M_I_C sections, one  for  each  network-context
  99. pair.   These  _A_T_O_M_I_C  files  contain the _D_T_E address of the
  100. host, the Yellow Book Transport Service address  if  any,  a
  101. list  of  application relays if any and the description text
  102. (in the DESC context only).  Therefore to  look  up  a  host
  103. involves three file accesses.
  104.  
  105. The purpose of the _n_r_s program, is to run through this  data
  106. in  one  go,  and  print it out in formats expected by other
  107. programs.
  108. NB: The _n_r_s program can be compiled so that only one or  two
  109. output  formats  are  selected. This is to cut down on space
  110. and memory requirements.  If this is the case,  some  output
  111. specific keywords may not be recognised.
  112.  
  113. _3.  _T_h_e _c_o_n_f_i_g_u_r_a_t_i_o_n _f_i_l_e
  114.  
  115.  
  116.         nrs [<config-file>] [<options>]*
  117.  
  118. The normal use is to supply _n_r_s with a  configuration  file,
  119. however other options may be added in the same format as the
  120. configuration file options to overide or alter  the  options
  121. in the configuration file.  This behaviour is similar to the
  122. way _a_w_k(1) treats its arguments.
  123.  
  124. Within the configuration file, of which there should be some
  125. examples  with  the  program, there are several lines giving
  126. control information to the nrs program.  Each line  is  read
  127.  
  128.  
  129.  
  130.                       December 3, 1988
  131.  
  132.  
  133.  
  134.  
  135.  
  136.                            - 3 -
  137.  
  138.  
  139. in turn and parsed into arguments.  Comment lines start with
  140. a hash `#' character and  are  completely  ignored,  as  are
  141. blank  lines.   All  other  lines  are  examined for control
  142. information.  The control line keywords are  generally  case
  143. insensitive,   but   where   they  specify  values  such  as
  144. filenames, the filenames must be in the right  case.   Argu-
  145. ments are separated by white space.
  146.  
  147.  
  148. _3._1.  _G_e_n_e_r_a_l _C_o_n_t_r_o_l _L_i_n_e_s
  149.  
  150. The following control lines have general use  regardless  of
  151. which mode the program is to run in.
  152.  
  153.         directory <directory-name>
  154.  
  155. This gives a directory name to prepend  to  all  input  file
  156. names,  thus  enabling  the  data  to  be separated from the
  157. results.  On UNIX a / is inserted between the directory  and
  158. the  filename, and the directory parameter if present can be
  159. overridden for a particular file by either giving  the  full
  160. pathname,  or  a relative pathname (one starting ./ or ../).
  161. On VMS the filename is directly suffixed  to  the  directory
  162. name,  but the directory is ignored if the pathname contains
  163. a colon (:), a dollar ($) or an open square bracket ([).  On
  164. PR1MEs  a  ket (>) is inserted between the directory and the
  165. filename, unless the file name contains a ket (>), in  which
  166. case it is used directly.
  167.  
  168.         derfil  <filename>
  169.  
  170. This control line sets up the name of the NRS  derived  file
  171. for  the _n_r_s program. If this line are missing, the filename
  172. will default to DERFIL2
  173.  
  174.         domains  [<filename>]
  175.  
  176. This control line instructs the  processor  to  include  the
  177. domain  gateway  information if the format supports it.  The
  178. filename is needed only if it  is  processing  filettes.   A
  179. destination file for the output should be given, i.e.
  180.  
  181.         filedmn top.dmn -top.dmn-
  182.  
  183. where the special  name  -top.dmn-  is  used  for  mmdf  and
  184. -top.dom- for sendmail.
  185.  
  186.         filedmn <file-name> [<short-dmn-name> [<long-dmn-name> [local]]]
  187.  
  188. These are used by mmdf and sendmail formats to specify where
  189. domain  table  information  is  to  be written for specified
  190. sub-domains.  If no long domain name is given it is  assumed
  191. to  be  identical  to  the  short  domain name.  If no short
  192. domain name is given, then the short  domain  is  set  to  a
  193.  
  194.  
  195.  
  196.                       December 3, 1988
  197.  
  198.  
  199.  
  200.  
  201.  
  202.                            - 4 -
  203.  
  204.  
  205. state  where it matches all domains, so this acts as a catch
  206. all.  As these tables are scanned in the order, the order in
  207. which  they  appear  is  critical.  To show how these fields
  208. work, an example of how the nottingham setup is configured.
  209.  
  210.         filedmn uk-ac-nott-dmn  uk.ac.nott. uk.ac.nottingham.
  211.         filedmn uk-ac-dmn       uk.ac.
  212.         filedmn uk-co-dmn       uk.co.
  213.         filedmn cern-dmn        cern.
  214.         filedmn desy-dmn        desy.
  215.         filedmn top-dmn         -top.dmn-
  216.         filedmn misc-dmn
  217.  
  218. This specifies that having got an address, it  is  run  down
  219. the list of preferred domains (as set by _s_h_o_r_t/_l_o_n_g ) to see
  220. if  any  are  a  prefix.  The  last  line  catches  anything
  221. unmatched.  So with a host such as
  222.  
  223.         short         long
  224.         uk.ac.nott.cs uk.ac.nottingham.computer-science
  225.  
  226. There is a match in the first line as uk.ac.nott. is a  pre-
  227. fix.   This  is  then marked as a hit and the long and short
  228. domains stripped off to give
  229.  
  230.         short         long
  231.         cs            computer-science
  232.  
  233. These are then put into the uk-ac-nott-dmn file as
  234.  
  235.         cs:computer-science.nottingham.ac.uk
  236.         computer-science:computer-science.nottingham.ac.uk
  237.  
  238. With a host such as uk.ac.ucl.cs, the first hit  is  in  the
  239. uk.ac.  entry  so the result is put into the uk-ac-dmn file.
  240. If the host has application relays, these are  listed  after
  241. the  entry  as  relays.   If  the  local flags is given, any
  242. application relays are supressed.
  243.  
  244.      Mmdf and sendmail have special domains,  -top.dmn-  and
  245. -top.dom- respectively, to which the NRS gateway information
  246. is  sent,  e.g.  the  fact  that  mail  to  MIL.   goes  via
  247. uk.ac.ucl.cs.    Sendmail   also   has  the  special  domain
  248. -abbrev.dom- which is where the  aliases  between  long  and
  249. short forms are put.
  250.  
  251.         filechan <filename> <network> [<prefix>]
  252.  
  253. Channel tables may also be  built  whilst  constructing  the
  254. domain  tables.  After putting the name into a domain table,
  255. the host is looked up in the list of  networks  attached  to
  256. the  filechan  control.  If a match is found, it is put into
  257. the associated filename.  A typical setup is
  258.  
  259.  
  260.  
  261.  
  262.                       December 3, 1988
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                            - 5 -
  269.  
  270.  
  271.  
  272.         filechan pss-chan       pss
  273.         filechan janet-chan     janet
  274.  
  275. The optional third argument, used only for MMDF, will  cause
  276. that  prefix  to  be  stripped off on the RHS of the channel
  277. table.  E.g.
  278.  
  279.         filechan janet-chan janet uk.ac.
  280.  
  281. will result in entries of the form
  282.  
  283.         name.host.ac.uk:host.name
  284.  
  285. which may help match up with entries in your x25  directory.
  286. For  sendmail  UK-1.4,  channel  table entries are only con-
  287. structed for mail sites which need applicatiom relays.
  288.  
  289.  
  290.         gateway [pss|janet] <gatewayhost>
  291.  
  292. This is used by  both  york  formats  and  smail  format  to
  293. specify a gateway host to a particular network.
  294.  
  295.         relay_host <hostname>
  296.  
  297. If this is present for MMDF format, then entries are matched
  298. in the list of domains as before, but have added after their
  299. entry the hostname specified in the relay_host  line.   This
  300. is so that if the host you are building the table for is not
  301. actually connected to the network directly, all hosts may be
  302. relayed  through  another  host  first to reach the network.
  303. E.g.
  304.  
  305.         relay_host hcig.nott.ac.uk
  306.  
  307. would alter the above case of ucl.cs to
  308.  
  309.         cs.ucl:cs.ucl.ac.uk hcig.nott.ac.uk
  310.  
  311. Any application relays in this case are thrown away.  It  is
  312. presumed  that  the relay host will know the best route from
  313. then on.  Sendmail UK-1.4 used a uk entry in top.dom  to  do
  314. off-janet sites.
  315.  
  316. However to stop spurious entries such as
  317.  
  318.         ourname:ourname.ourdomain.ac.uk relayhost
  319.  
  320. which is an infinite loop, the local keyword is attached  to
  321. a domain which suppresses the relayhost for those entries.
  322.  
  323.         verbose [<number>]
  324.  
  325.  
  326.  
  327.  
  328.                       December 3, 1988
  329.  
  330.  
  331.  
  332.  
  333.  
  334.                            - 6 -
  335.  
  336.  
  337. This parameter sets the level of information  messages  pro-
  338. duced  to number (or one if missing).  If no _v_e_r_b_o_s_e control
  339. line is present, or the verbose setting  is  0,  only  fatal
  340. errors and warning messages will be given.
  341.  
  342.         context <context> <network>
  343.  
  344. This control line specifies to  the  _n_r_s  program  that  the
  345. _A_T_O_M_I_C  section  for the given context and the given network
  346. should be used.  The context parameter may  be  any  of  the
  347. following keywords.
  348.  
  349. X29           Remote login to an interactive  service  using
  350.               X29.
  351.  
  352. TS29          Remote login to an interactive  service  using
  353.               TS29.
  354.  
  355. NIFTP         File access to some filestore using NIFTP pro-
  356.               tocol.
  357.  
  358. FTP           A synonym for above
  359.  
  360. MAIL-NIFTP    Electronic  mail  to  an  individual  in  some
  361.               organisation,  using  Grey  Book Mail protocol
  362.               over NIFTP.
  363.  
  364. MAIL          A synonym for above.
  365.  
  366. MAIL-X29      Electronic mail over X29 connections.
  367.  
  368. MAIL-TELEX    Electronic mail to Telex Machines
  369.  
  370. JTMP          Job Transfer  and  Manipulation  Protocol  for
  371.               running jobs and printing output.
  372.  
  373. JTMP-FILES    File store references with in JTMP descriptors
  374.               (whatever that means!).
  375.  
  376. JTMP-REG      Registration  authorities  referenced   within
  377.               JTMP descriptors (ditto).
  378.  
  379. YBTS-NODE     Yellow Book Transport Service locations (???)
  380.  
  381. YBTS          Yellow  Book  Transport  service  interprocess
  382.               connections (???)
  383.  
  384. DESC          The Description Text for the host.
  385.  
  386.  
  387. A complete set of contexts and networks should be  found  in
  388. the york configuration file supplied as an example.
  389.  
  390. The network keyword is currently one of
  391.  
  392.  
  393.  
  394.                       December 3, 1988
  395.  
  396.  
  397.  
  398.  
  399.  
  400.                            - 7 -
  401.  
  402.  
  403. JANET         The Joint Academic network.
  404.  
  405. PSS           The British Telecom Packet Switched network.
  406.  
  407. TELEX         The Telex network.
  408.  
  409. Often, for  a  particular  type  of  output,  you  are  only
  410. interested in certain combinations of contexts and networks,
  411. for instance mmdf is only interested in mail  addresses,  so
  412. most   of  the  contexts  are  redundant  and  shouldn't  be
  413. included.
  414.  
  415.         file <filename> <context> <network>
  416.         module2 <filename>
  417.         module3 <filename>
  418.         module4 <filename>
  419.  
  420. These are used for the old filettes format (do not use these
  421. - use DERFIL2).  They map a section onto a filename.
  422.  
  423. _3._2.  _O_u_t_p_u_t _s_p_e_c_i_f_i_c _c_o_n_t_r_o_l _l_i_n_e_s.
  424.  
  425. The output format is specified by the output  keyword  which
  426. takes  optional  flags  indicating  a preference for long or
  427. short names, the desired mapping as forward or  reverse  and
  428. the  desired  case  of  the output.  After this may come the
  429. mode and any mode specific options.
  430.  
  431.         output [long|short] [forward|reverse] [mixed|lower] [<mode> [<option>]*]
  432.  
  433. Several of the modes have a `preferred' mapping  (i.e.  long
  434. or  short);  in  mmdf  mode it determines which form appears
  435. first in the tables, the form of the RHS of the domain table
  436. and  the  form  of  the  channel  table; in sendmail mode it
  437. specifies which is the main name, and which  is  the  alias.
  438. If  there  are no explicit instructions for the requied for-
  439. mat, do not quote either form.
  440.  
  441. Normally the sequence is to scan through  the  MODULE2  sec-
  442. tion,  reading each record in turn and looking up the values
  443. in the other sections.  This  behaviour  gives  the  forward
  444. lookup  type  tables.   If  reverse is set, then the MODULE3
  445. section is read in a  record  at  a  time  and  the  various
  446. records  from  other  sections  are collected.  This sort of
  447. processing  gives  reverse  lookup  type  tables,   and   is
  448. currently  only  generally  useful with york and text format
  449. output.
  450.  
  451. The case of the produced output can be selected  by  use  of
  452. the _m_i_x_e_d/_l_o_w_e_r flags which leave the case as it is (usually
  453. UPPER CASE), or force it to lower case.
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.                       December 3, 1988
  461.  
  462.  
  463.  
  464.  
  465.  
  466.                            - 8 -
  467.  
  468.  
  469. _3._2._1.  _Y_o_r_k _F_o_r_m_a_t _O_u_t_p_u_t
  470.  
  471.  
  472.         output york
  473.         output york2.1 [<prefix>]
  474.  
  475. The optional second parameter represents a prefix string  to
  476. strip off all names and is applicable only to the older for-
  477. mat (R2.1) directory format.  This format should not be used
  478. as it is highly deficient.
  479.  
  480.         output york2.1 uk.ac.
  481.  
  482. makes uk.ac.cam.cl appear as cam.cl.  With D2.2  the  direc-
  483. tory contains the full names, and the stripping is done much
  484. more cleverly by the programme which created the DBM file.
  485.  
  486. _f_o_r_w_a_r_d/_r_e_v_e_r_s_e indicate the direction of the mapping.
  487.  
  488.  
  489.         gateway <network> <string>
  490.  
  491. Gateway is used if you have to go through a gateway  to  get
  492. to  a  network.   The  network argument may be pss or janet.
  493. The string is prefixed to any DTE on the specified  network.
  494. E.g.
  495.  
  496.         Gateway PSS 000000002105/
  497.  
  498. produces lines of the form
  499.  
  500.         0:PSS:X:psshost:000000002105/000012345678:
  501.  
  502.  
  503. _3._2._2.  _M_M_D_F _f_o_r_m_a_t _o_u_t_p_u_t
  504.  
  505. This is rather more complicated than the  york  format,  but
  506. with an example config file it shouldn't be too hard ...
  507.  
  508. _s_h_o_r_t/_l_o_n_g      indicates whether to generate an mmdf domain
  509.                 table  mapping  short  to long addresses, or
  510.                 long to short address.
  511.  
  512. The output in mmdf format is set up by the control line
  513.  
  514.         output mmdf
  515.  
  516. The hard  part  comes  in  working  out  what  domains  your
  517. interested  in  and  what  to do with them - see filedmn for
  518. domain tables and filechan for channel tables.
  519.  
  520. _3._2._3.  _x_2_5_h_o_s_t_s _f_o_r_m_a_t _o_u_t_p_u_t
  521.  
  522. This format is useful if you are in need  of  an  /etc/hosts
  523.  
  524.  
  525.  
  526.                       December 3, 1988
  527.  
  528.  
  529.  
  530.  
  531.  
  532.                            - 9 -
  533.  
  534.  
  535. type  of  format.  It only lists entries without application
  536. relays or yellow book transport  service  strings.  This  is
  537. currently  only used by the UBC X25 software but may be used
  538. by other 4.2 networking code in the future.
  539.  
  540. It is enabled by the line
  541.  
  542.         output x25hosts [<prefix>]
  543.  
  544. The optional second argument is assumed to be  a  prefix  to
  545. strip off the entries.  The output format is
  546.  
  547.         dteaddr [stripped-form] short-form long-form
  548.  
  549. Addresses with application relays are discarded.
  550.  
  551. _3._2._4.  _T_e_x_t _f_o_r_m_a_t _o_u_t_p_u_t
  552.  
  553.  
  554. _f_o_r_w_a_r_d/_r_e_v_e_r_s_e should be set as appropriate.
  555.  
  556. _s_h_o_r_t/_l_o_n_g      selects the format in which the name  is  to
  557.                 be printed.  The default is to print both.
  558.  
  559.  
  560.         output text
  561.  
  562.  
  563. The output is in `human readable'  format.   This  is  in  a
  564. similar style to the NRS `t.central' format.
  565.  
  566. _3._2._5.  _V_M_S _f_o_r_m_a_t _o_u_t_p_u_t
  567.  
  568.  
  569.         output [ignorerelay] vms
  570.  
  571.  
  572. The output is in a format for feeding into NETAUTH,  one  of
  573. the  programmes  in  the "Coloured Books" package written by
  574. UWIST and St Andrews and marketed by  DEC  which  runs  over
  575. PSI.   The  standard header actually generates a DCL command
  576. file.  This produces optimised commands to process all names
  577. of less than 33 characters (a limitation applied by NETAUTH)
  578. of the form
  579.  
  580.         D nrsname
  581.         A nrsname+=commonDTEprefix+context1=suffix1+context2=suffix2
  582.  
  583. It puts quotes wherever there are  any  suspect  characters,
  584. arranges for the context with a null suffix to appear at the
  585. end, handles different DTEs for the same name, etc. etc..
  586. However, the algorithms were worked out by guess work so may
  587. need fixing.
  588. NETAUTH cannot make any use of application relays, so if the
  589.  
  590.  
  591.  
  592.                       December 3, 1988
  593.  
  594.  
  595.  
  596.  
  597.  
  598.                            - 10 -
  599.  
  600.  
  601. programme  is  being  used  as  an NRS table generator, then
  602. these entries are omitted.  However, if it is being used  as
  603. a  GreyBook  table  generator, it is permissable to omit the
  604. application relays, so the flag _i_g_n_o_r_e_r_e_l_a_y  can  be  given,
  605. and  the  entries  will  be  generated  with the application
  606. relays doscarded.
  607.  
  608. _3._2._6.  _S_e_n_d_m_a_i_l _a_n_d _S_m_a_i_l _f_o_r_m_a_t _o_u_t_p_u_t
  609.  
  610.  
  611. _s_h_o_r_t/_l_o_n_g      should be set as  appropriate  for  sendmail
  612.                 (ignored by smail).
  613.  
  614.  
  615.         output sendmail
  616.         output smail
  617.  
  618.  
  619. The output is for processing by Jim Crammond's  UK  Sendmail
  620. package,  or  Reading's  smail.   The sendmail info is based
  621. upon mmdf's domain and channel tables (see mmdf mode)
  622.  
  623. _3._2._7.  _D_B_M (_u_n_i_x-_n_i_f_t_p) _f_o_r_m_a_t _o_u_t_p_u_t
  624.  
  625.  
  626. _f_o_r_w_a_r_d/_r_e_v_e_r_s_e should be set as appropriate.
  627.  
  628. _s_h_o_r_t/_l_o_n_g      indicates whether the long or short form  is
  629.                 the primary key.
  630.  
  631.  
  632.         output dbm
  633.  
  634.  
  635. The output is in a format for feeding into  dbmencode  after
  636. optional editing of fields not supplied by the NRS.
  637.  
  638. _3._2._8.  _P_R_1_M_E _t_e_x_t _f_o_r_m_a_t _o_u_t_p_u_t
  639.  
  640.  
  641. _f_o_r_w_a_r_d/_r_e_v_e_r_s_e should be set as appropriate.
  642.  
  643.  
  644.         output prime
  645.  
  646.  
  647. The output is in a format used on PR1ME systems, and is very
  648. similar to t.central.
  649.  
  650. _3._2._9.  _E_d_i_n_b_u_r_g_h _t_e_x_t _f_o_r_m_a_t _o_u_t_p_u_t
  651.  
  652.  
  653.         output edtext [simple|short|long]
  654.  
  655.  
  656.  
  657.  
  658.                       December 3, 1988
  659.  
  660.  
  661.  
  662.  
  663.  
  664.                            - 11 -
  665.  
  666.  
  667. The output is in a text format devised  in  Edinburgh,  much
  668. preferable  to t.central.  If short and/or long is specified
  669. every line is to be prefixed with the relevant name, e.g. to
  670. allow  a simple search to return the useful information.  If
  671. no flag is given, short is used (simple implies no names).
  672.  
  673. This format is intended to dump the ENTIRE database, so  ALL
  674. contexts  should be requested.  If this is not done, a warn-
  675. ing is generated when the  first  missing  context  is  pro-
  676. cessed.
  677.  
  678. _4.  _S_u_p_p_l_e_m_e_n_t_a_l _c_o_m_m_a_n_d_s
  679.  
  680.  
  681.         comment <filename>
  682.  
  683. will cause the contents of the file  given  to  be  filtered
  684. through  a  small macro expander which replaces certain keys
  685. with values rather like RCS keywords,  when  writing  to  an
  686. output  for  the  first time.  This helps keep files in sync
  687. across several machines.  At present the following keys  are
  688. expanded:
  689.  
  690. $C$  This expands to some text relevant to the output type.
  691.  
  692. $D$  The current date and time in ctime(3) format.
  693.  
  694. $F$  The current file name.
  695.  
  696. $H$  The hostname of this host. This may  be  set  with  the
  697.      control _h_o_s_t_n_a_m_e _s_t_r_i_n_g (see below).
  698.  
  699. $N$  The Version of the NRS database used in  building  this
  700.      file.   This  information  is gleaned from the database
  701.      headers.
  702.  
  703.  
  704.         hostname <name>
  705.  
  706. specifies the hostname for  the  comment  field  $H$.   This
  707. overrides  the  name  returned  by  the gethostname (BSD) or
  708. uname (USG) call.
  709.  
  710. _5.  _E_r_r_o_r _m_e_s_s_a_g_e_s.
  711.  
  712. Most error messages are hopefully self  explanatory,  but  a
  713. few could bear further explanation.
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.                       December 3, 1988
  725.  
  726.  
  727.  
  728.  
  729.  
  730.                            - 12 -
  731.  
  732.  
  733.  
  734.         lru botch - can't reclaim an lru file descriptor.
  735.         problem on getm2rec rec %d - bad format MODULE2 section
  736.         Can't find corresponding short entry for %s
  737.                 - again a bad format MODULE2 section
  738.         problem on getm4rec rec %d - bad format MODULE4 section
  739.         already got a dte - a host has more than one dte address
  740.         already got a yb - a host has more than one ybts string
  741.         unknown line, '%s' '%s' - bad format atomic file
  742.         Files are out of sync - the atomic files + the modules files
  743.                         are not all from the same run of the salford
  744.                         database - reget the atomic + modules files.
  745.  
  746.  
  747. _6.  _P_r_o_b_l_e_m_s
  748.  
  749. No doubt there will be problems ...  if so you  can  contact
  750. any of us at:
  751.  
  752.         Email Addresses:
  753.  
  754.         jpo@uk.ac.nott.cs (jpo@uk.ac.nottingham.computer-science)
  755.         jpo@uk.ac.nott.hcig (jpo@uk.ac.nottingham.psychology.hcig)
  756.  
  757.         pb@uk.ac.cam.cl (pb@uk.ac.cambridge.computer-lab)
  758.         cam-cl.uucp!pb (...mcvax!ukc!cam-cl!pb)
  759.  
  760.         A.R.Pell@uk.ac.reading
  761.  
  762. Alternatively if you're really stuck try
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.  
  790.                       December 3, 1988
  791.  
  792.  
  793.  
  794.  
  795.  
  796.                            - 13 -
  797.  
  798.  
  799.  
  800.         Snail Mail:
  801.  
  802.         Julian Onions
  803.         Computer Science Group,
  804.         Nottingham University
  805.         University Park,
  806.         Nottingham
  807.         NG7 2RD
  808.         (+44) 602 506101 x3595
  809.  
  810.         Piete Brooks
  811.         Computer Laboratory,
  812.         New Museum Site,
  813.         Pembroke Street,
  814.         Cambridge
  815.         CB2 3QG
  816.         (+44) 223 334659 (DDI)
  817.  
  818.         Adrian Pell
  819.         Dept. of Computer Science
  820.         University of Reading
  821.         PO Box 220
  822.         Reading
  823.         RG6 2AX
  824.         (+44) 734 875123 x 411
  825.  
  826.  
  827.  
  828.  
  829.  
  830.  
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.  
  839.  
  840.  
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.                       December 3, 1988
  857.  
  858.  
  859.